home *** CD-ROM | disk | FTP | other *** search
/ Acorn User: China / Acorn User China CD-ROM (UK) (Disc A) / Acorn User China CD-ROM (UK) (Disc A).bin / DEMON / DEVELOPER / NSPARK / NSPK176B.EXE / ARCFS5.TXT next >
Encoding:
Text File  |  1995-08-01  |  5.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. ARCFS(5)                  FILE FORMATS                   ARCFS(5)
  5.  
  6.  
  7.  
  8. NAME
  9.      ArcFS - Archive file format for the RISC OS ArcFS filesystem
  10.  
  11. CONVENTIONS
  12.      Strings are given in ASCII with  C-style  escapes.  No  ter-
  13.      minating   is present if not explicitly included.
  14.  
  15.      Words are 32 bit little-endian numbers.
  16.  
  17.      Half words are 16 bit little-endian numbers.
  18.  
  19.      This document describes format version 0, for ArcFS  minimum
  20.      versions  0.40  and  1.00, and version 0a, for ArcFS minimum
  21.      versions 0.58 and 2.17.
  22.  
  23.  
  24. FORMAT
  25.      The file consists of a file header, a  sequence  of  archive
  26.      headers, then a sequence of compressed files.
  27.  
  28.  
  29. FILE HEADER
  30.      _F_i_l_e _s_t_r_i_n_g _s_i_g_n_a_t_u_r_e
  31.      The string "Archive" followed by a zero byte.
  32.  
  33.      _H_e_a_d_e_r _l_e_n_g_t_h
  34.      Length of header info in bytes, one word, multiple of 36.
  35.  
  36.      _D_a_t_a _o_f_f_s_e_t
  37.      Offset, in bytes, into archive at  which  data  starts,  one
  38.      word.
  39.  
  40.      _R_e_a_d-_o_n_l_y _v_e_r_s_i_o_n
  41.      Minimum read-only version required, multiplied by  100,  one
  42.      word.
  43.  
  44.      _R_e_a_d-_w_r_i_t_e _v_e_r_s_i_o_n
  45.      Minimum read--write version required, multiplied by 100, one
  46.      word.
  47.  
  48.      _R_e_s_e_r_v_e_d
  49.      Reserved for future use, 68 bytes.
  50.  
  51.  
  52. ARCHIVE HEADER
  53.      The last header starts at 60+length of headers and  ends  at
  54.      96+length  of  headers. The format of each header is as fol-
  55.      lows.
  56.  
  57.      _I_n_f_o _b_y_t_e
  58.      Object information byte, show compression method used:
  59.           0x00 end of directory marker
  60.  
  61.  
  62.  
  63. Sun Release 4.1           Last change:                          1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ARCFS(5)                  FILE FORMATS                   ARCFS(5)
  71.  
  72.  
  73.  
  74.           0x01 object has been deleted
  75.           0x82 stored
  76.           0x83 packed
  77.           0x88 crunched
  78.           0xFF compressed
  79.  
  80.      _F_i_l_e _n_a_m_e
  81.      File name, 11 bytes.
  82.  
  83.      _F_u_l_l _l_e_n_g_t_h
  84.      Original file length, or 0xFFFFFFFF for  a  directory),  one
  85.      word.
  86.  
  87.      _L_o_a_d _a_d_d_r_e_s_s
  88.      Load address of the file, or 0xFFFFFFdd  for  a  directory),
  89.      one word.
  90.  
  91.      _E_x_e_c _a_d_d_r_e_s_s
  92.      Exec address of the file, or 0xdddddddd  for  a  directory),
  93.      one word.
  94.  
  95.      File load and execution address may contain a  filetype  and
  96.      datestamp as normal.
  97.  
  98.      Directories can be date-stamped, the number of  centiseconds
  99.      since  the  1st  January 1900 when the directory was created
  100.      are given by &dddddddddd contained in the  directory's  load
  101.      and execution addresses as shown above.
  102.  
  103.      Archives converted from spark(5) format using  ArcConv  will
  104.      have  the  same full length, compressed length, load address
  105.      and execute address as they had in the Spark archive.
  106.  
  107.      _A_t_t_r_i_b_u_t_e_s
  108.      Attributes of the file, one word.  Contains  the  number  of
  109.      bits  compression  for  crunch and compress format files and
  110.      the least significant bytes contains the  standard  RISC  OS
  111.      information on file access.
  112.  
  113.      _C_o_m_p_r_e_s_s_e_d _l_e_n_g_t_h
  114.      Length of compressed data, or 0xFFFFFFFF  for  a  directory,
  115.      one word.
  116.  
  117.      _I_n_f_o_r_m_a_t_i_o_n _w_o_r_d
  118.      The top bit (definitively) indicates whether the object is a
  119.      file or a directory, 0 for a file, 1 for a directory.
  120.  
  121.      In the case of a file, the least significant  31  bits  show
  122.      the offset from the start of data at which the file data can
  123.      be found.
  124.  
  125.      In the case of a directory, the least  significant  31  bits
  126.  
  127.  
  128.  
  129. Sun Release 4.1           Last change:                          2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ARCFS(5)                  FILE FORMATS                   ARCFS(5)
  137.  
  138.  
  139.  
  140.      show  the offset from the start of headers (96) at which the
  141.      next object in this directory can be  found,  the  following
  142.      object being the first in the sub-directory.
  143.  
  144.  
  145. FORMAT VERSION 0a
  146.      This archive format is backwards  compatible  with  versions
  147.      0.40  and  1.00,  the  only difference being that there is a
  148.      block of catalogue  information  immediately  prior  to  the
  149.      start of each file's data as described below.
  150.  
  151.      Note that this information is there to aid the  recovery  of
  152.      most  files  in  the  event of archive corruption and is not
  153.      used by ArcFS.
  154.  
  155.      Note, also that Compact and Autocompact in release  versions
  156.      1.09,  2.02 and 2.11 will compact out the catalogue informa-
  157.      tion blocks, so try to avoid writing to  new  archives  with
  158.      old versions of ArcFS.
  159.  
  160.      _M_a_r_k_e_r
  161.      A marker to indicate the start of a file, the string "FileData", not terminated.
  162.  
  163.      _I_n_f_o _b_y_t_e
  164.      One byte, as above.
  165.  
  166.      _L_e_a_f _n_a_m_e
  167.      The file name, 11 bytes.
  168.  
  169.      _F_u_l_l _l_e_n_g_t_h
  170.      One word, as above.
  171.  
  172.      _L_o_a_d _a_d_d_r_e_s_s
  173.      One word, as above.
  174.  
  175.      _E_x_e_c _a_d_d_r_e_s_s
  176.      One word, as above.
  177.  
  178.      _A_t_t_r_i_b_u_t_e_s
  179.      One word, as above.
  180.  
  181.  
  182. SEE ALSO
  183.      spark(5), nspark(1)
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Sun Release 4.1           Last change:                          3
  196.  
  197.  
  198.  
  199.